home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / c / csourc.zip / CSOURC.DOC next >
Text File  |  1987-07-16  |  6KB  |  128 lines
  1. CSOURCE V1.0
  2. ------------
  3.  
  4.      Thanks for using CSOURCE.  I'm sure it will prove as useful to you
  5. as it does for me.  CSOURCE requires very little printed documentation.  
  6. Most of the help you will need can be obtained through CSOURCE itself.  The
  7. following is a brief summary of how to start CSOURCE and a few other pieces
  8. of information that you may find useful.
  9.  
  10.  
  11. GETTING STARTED
  12. ---------------
  13.  
  14.      To get started, type CSOURCE at the DOS prompt.  You will be presented
  15. with an input screen.  Pressing F2 displays a help screen (after first
  16. displaying an introduction screen) showing the various ways possible to
  17. enter source files.  There are basically three ways to enter files:
  18.  
  19.      1.  C>  CSOURCE
  20.          --- No command line parameters.  When CSOURCE sees that there are
  21.              no command line parameters, you are taken directly to the
  22.              input screen where source files are entered manually.
  23.  
  24.      2.  C>  CSOURCE FILES.LST
  25.          --- A file name is passed as a command line parameter.  Since there
  26.              are no wildcard characters in the file name, CSOURCE assumes
  27.              that all the files you wish entered are contained in file
  28.              FILES.LST.  Note that this file name could have contained a full
  29.              drive and path name.  For example, "c:\directory\files.lst"
  30.              would have been perfectly ok.
  31.  
  32.      3.  C>  CSOURCE *.c
  33.          --- The command line parameter contains wildcard characters.  CSOURCE
  34.              will therefore include all files with a ".c" extension.  A drive 
  35.              and path name could be included.  For example,  "c:\directory\*.c"
  36.              will include all ".c" files in the "directory" directory.
  37.  
  38.  
  39. INPUT SCREEN
  40. ------------
  41.  
  42.      Only the first method listed above takes you to the input screen.  The
  43. other two causes the input screen to be bypassed.  Once here, entering files
  44. is simple.  If a file name is entered without a drive letter or path name,
  45. the current working directory is searched.  Otherwise, the path name is
  46. searched.
  47.      Wildcard characters are permitted.  Entering "*.c" causes the current
  48. working directory to be searched for all ".c" files.  Entering "c:\*.c"
  49. causes the root directory to be searched for all ".c" files.  When entering
  50. wildcard characters, after the search for files is completed, a message will
  51. be displayed telling you how many files were found.
  52.      If a file cannot be found or a subdirectory does not exist, a message 
  53. will pop up informing you of a problem.  Once the message disappears, you
  54. are free to make any changes you wish to the file name.  You can edit the
  55. line of input using the arrow keys and backspace and delete keys.
  56.      You should also notice a status line on the bottom of the screen giving
  57. more directions.
  58.      The limit on the number of source files that can be entered is 500.
  59.  
  60.  
  61.  
  62.  
  63. MAIN MENU
  64. ---------
  65.  
  66.      After the input screen is completed or if you chose to enter files by
  67. one of the last two methods listed above, you are taken to the main menu
  68. screen.  All the help you will need can be obtained by positioning the cursor
  69. over a particular field of input and pressing the F1 key.  CSOURCE keeps 
  70. track of where you are in the menu and will display the appropiate help
  71. message.
  72.      One area that may not be clear is extractions.  CSOURCE lets you extract
  73. portions of you code to the screen, printer or a file of your choice.
  74. After you press the F10 key to tell CSOURCE that you are done, you will be
  75. given the chance to extract portions of your source code (assuming you
  76. selected the extract option).  It will look as follows:
  77.  
  78.      Source File:  c:\directory\filename.ext
  79.  
  80.      Extraction #1:  
  81.  
  82. You are allowed 10 extractions.  Enter extractions as follows (where the
  83. numbers are line numbers):
  84.  
  85.      Extraction #1:  45:90    (or)  45-90
  86.      Extraction #2:  121:209  (or)  121-209
  87.      Extraction #3:  300:415  (or)  300-415
  88.      Extraction #4:  (Press <return> to tell CSOURCE you're done)
  89.  
  90. If you entered more than one source file, you will be given the chance to
  91. extract code from each file.
  92.  
  93.  
  94. ERROR CHECKING
  95. --------------
  96.  
  97.      CSOURCE does some error checking on your source code.  It will tell
  98. you if you have mismatched braces, mismatched single or double quotation
  99. marks and mismatched comment symbols.  Since most compilers do not allow
  100. nested comments, CSOURCE will not allow it either.  If you have mismatched
  101. braces, CSOURCE will display a message telling you so but will keep going.  
  102. Any other error causes CSOURCE to stop and tell you the problem and the line
  103. number(s) of occurrence.  You will then be taken back to the DOS prompt to
  104. correct the error and to try again.
  105.  
  106.  
  107. SOURCE CODE AVAILABLE
  108. ---------------------
  109.  
  110.      If you are a first time user, please press F2 at the input screen.  The
  111. shareware nature of this program will be explained as well as how to get a
  112. copy of the source code.  If you have any further questions, you can contact
  113. me at the address listed or through Compuserve.  Thanks again for using
  114. CSOURCE.
  115.  
  116.  
  117. FOR YOUR INFORMATION
  118. --------------------
  119.  
  120.      CSOURCE was written entirely in C and contains approximately 3,500 lines
  121. of code.  The version you are currently using was compiled under Aztec C.
  122. I am in the process of converting to Turbo C.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.